home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / disk & file tools / catchdisk / english / documentation / catchdisk.doc next >
Text File  |  1996-04-07  |  18KB  |  496 lines
  1.  
  2.  
  3.  
  4. -------------------------------------------------------------------------------
  5.                              CatchDisk: User Guide                             
  6. -------------------------------------------------------------------------------
  7.  
  8.  ------------------------------------------------------------------------------
  9.                        CatchDisk version 1.20 26-Apr-1994
  10.                       Copyright © 1994 By Alessandro Sala
  11.                             dedicated to Cristina
  12.  
  13.  
  14.                Requires AmigaOS v2.04 ( Kickstart v37 ) or later
  15.              and WBStart-Handler v1.4 or later (by Stefan Becker)
  16.  ------------------------------------------------------------------------------
  17.  
  18.  
  19.                                     Contents
  20.  
  21.  
  22.                         - Legal info              
  23.                         - The distribution archive
  24.                         - Introduction
  25.                             What is CatchDisk ?   
  26.                             Installation          
  27.                         - Configuration and usage 
  28.                         - Terminating CatchDisk   
  29.                         - Contact Addresses       
  30.                         - Revision history        
  31.  
  32.  
  33.  
  34.  
  35.       ******************************************************************
  36.  
  37.  
  38.         PLEASE NOTE: My E-Mail address has changed. My new address is:
  39.  
  40.  
  41.       +----------------------------------------------------------------+
  42.       |                                                                |
  43.       |                         Alessandro Sala                        |
  44.       |                                                                |
  45.       |                   tser1500@cdc8g5.cdc.polimi.it                |
  46.       |                                                                |
  47.       +----------------------------------------------------------------+
  48.  
  49.  
  50.  
  51. ----------
  52. Legal info
  53. ----------
  54.  
  55.                                   ------------
  56.                                    Disclaimer
  57.                                   ------------
  58.  
  59.  
  60.    This program is provided "as is" without warranty of any kind, either
  61. expressed or implied, including, but not limited to, the implied warranty
  62. of fitness for a particular purpose.  Though every care has been taken to
  63. make this program system-friendly and bugs-free, the entire risk as to the
  64. results, reliability and performance of this program is assumed by you.
  65.  
  66.  
  67.  
  68.                                ------------------
  69.                                 Copyright notice
  70.                                ------------------
  71.  
  72.  
  73.    This program is "FreeWare": it can be freely copied and distributed for
  74. non-commercial purposes, provided that no file is added to or removed from the
  75. distribution archive and no charge, beside a nominal fee, is requested.
  76.  
  77.  
  78.    Fred Fish is, of course, explicitly allowed to put this program on his
  79. great disk library and/or on his CD-ROMs.
  80.  
  81.  
  82.    Nevertheless the program remains COPYRIGHT of the Author: you cannot
  83. patch, reverse engineer or otherwise modify the program, the documentation and
  84. every other file found in the distribution archive except where explicitly
  85. allowed.
  86.    Compressing in executable form is allowed for personal use but not
  87. for distribution. The only two allowed forms of distribution are the original
  88. lharc'ed archive or a uncompresssed form of it.
  89.    Furthermore you cannot embed the program in any other software without
  90. the written permission of the author.
  91.  
  92.  
  93.  
  94. ------------------------
  95. The distribution archive
  96. ------------------------
  97.  
  98.  
  99.                       ------------------------------------
  100.                       Contents of the distribution archive
  101.                       ------------------------------------
  102.  
  103.  
  104.     CatchDisk           : The main program
  105.     CatchDisk.info      : Related '.info' file with pre-set tooltypes
  106.  
  107.  
  108.     Italiano
  109.       Leggimi           : General information in italian language
  110.       Documentazione
  111.         CatchDisk.doc   : Italian documentation in ASCII format
  112.         CatchDisk.guide : Italian documentation in AmigaGuide format
  113.       Installa          : Installation program in italian language (see Leggimi)
  114.  
  115.     English
  116.       Readme            : General information in English language
  117.       Documentation
  118.         CatchDisk.doc   : English documentation in ASCII format
  119.         CatchDisk.guide : English documentation in AmigaGuide format
  120.       Install           : Installation program in English language (see Readme)
  121.  
  122.     Deutsch        ( translations by Jan-Claas Dirks )
  123.       Liesmich          : General information in German language
  124.       Dokumentation
  125.         CatchDisk.dok   : German documentation in ASCII format
  126.         CatchDisk.guide : German documentation in AmigaGuide format
  127.       Install           : Installation program in German language (see Liesmich)
  128.  
  129.  
  130.     Catalogs
  131.       CatchDisk.ct        : Empty translation file
  132.       italiano
  133.         CatchDisk.catalog : Italian language support file
  134.       deutsch
  135.         CatchDisk.catalog : German language support file (by Jan-Claas Dirks)
  136.  
  137.  
  138.  
  139.     Various '.info' files
  140.  
  141.  
  142.  
  143. ------------
  144. Introduction
  145. ------------
  146.  
  147.  
  148.                                What is CatchDisk ?
  149.                                ------------------
  150.  
  151.  
  152. CatchDisk is a simple commodity: its purpose is to detect when a new disk
  153. is inserted in any drive and check if it is properly formatted: if not,
  154. CatchDisk executes the Format program with the drive, in which the disk was
  155. inserted, already selected. The user has only to choose the format options and
  156. start or abort the operation. Besides, from v1.20 CatchDisk can recognize
  157. various non-DOS disks and ignore them, or run a user-chosen program when they
  158. are inserted. For more info and other features, read on.
  159.  
  160.  
  161.                                    IMPORTANT
  162.                                    ---------
  163. To use CatchDisk you must have the WBStart-Handler in you L: directory. You
  164. NEED VERSION 1.4 OR LATER of the handler. WBStart-Handler is a freely
  165. distributable software by Stefan Becker: you can find it as 'WBStart1_4.lha'
  166. in many FTP sites or from PD distributors. Please note that the version
  167. required is at least v1.4, because previous versions had problems when dealing
  168. with null locks.
  169.  
  170.  
  171.  
  172.  
  173.  
  174.                                   Installation
  175.                                   ------------
  176.  
  177.  
  178.    To install CatchDisk, if you have the 'Installer' utility from Commodore (see
  179. Readme), you can simply double-click the 'Install' icon found in the 'English'
  180. drawer.
  181.    Differently, you can simply copy CatchDisk in some drawer, typically
  182. your SYS:WBStartup drawer. If you have OS 2.1 or later and you want to
  183. take advantage of localization, you must also copy the 'catalogs' drawer, found
  184. in the CatchDisk distribution archive, into the same drawer as CatchDisk, or
  185. you can copy the 'CatchDisk.catalog' file ( found in the 'catalogs/<language>/'
  186. drawer ) into your 'LOCALE:catalogs/<language>/' drawer.
  187.    If your language is not currently available, you can fill in the empty
  188. translation file found in the catalogs drawer ( catalogs/CatchDisk.ct ) and
  189. send it to me by E-Mail ( see the Contact Addresses section ). I will
  190. create a new '<your-language>/CatchDisk.catalog' file and E-Mail it to you as
  191. soon as possible, and the next version of CatchDisk will support one more
  192. language. You can also translate the documentation files and send them to me
  193. for inclusion in the distribution of CatchDisk.
  194. You must also have WBStart-Handler in you L: directory for CatchDisk to work
  195. (see 'What is CatchDisk'.)
  196.  
  197.  
  198.  
  199. -----------------------
  200. Configuration and usage
  201. -----------------------
  202.  
  203.  
  204.  
  205.   To start CatchDisk simply double-click its icon or type 'run CatchDisk' from
  206. a CLI. To have it activated on every bootstrap, place it in your SYS:WBStartup
  207. drawer with the 'DONOTWAIT' tooltype, or insert 'run CatchDisk' in your
  208. S:user-startup file.
  209.   CatchDisk recognizes the following ToolTypes or CLI arguments:
  210.  
  211.  
  212.           CX_PRIORITY=<pri>     : The priority of CatchDisk in the commodities
  213.                                   network.
  214.                                   Default value = 0. Range = -128 to 127
  215.  
  216.  
  217.           DEVICE<n>=<drive>     : It describes a group of alternative drives
  218.                                     for a single physical drive.
  219.                                     The digit <n> identifies the group of
  220.                                     alternative drives, and can range from 0
  221.                                     to 9.
  222.                                     The <drive> parameter is the name of a
  223.                                     drive followed by ':', and you can list
  224.                                     any number of drives, without in-between
  225.                                     spaces.
  226.  
  227.  
  228.                                   Example:
  229.  
  230.  
  231.                                         'DEVICE0=DF0:PC0:'
  232.  
  233.  
  234.                                     tells CatchDisk that for a disk to be
  235.                                     considered properly formatted, it must be
  236.                                     readable accessing the drive as 'DF0:' or
  237.                                     as 'PC0:'.
  238.                                     If neither can read the disk, CatchDisk
  239.                                     will try to identify it from the first
  240.                                     4 bytes of track 0 (they are the 4
  241.                                     characters you can see under the Workbench
  242.                                     icon for the disk, after the DFx:). If
  243.                                     the disk is recognized, an action will be
  244.                                     taken, according to the REQUESTER and
  245.                                     ID<x> tooltypes, otherwise, according to 
  246.                                     the REQUESTER tooltype,  the format program
  247.                                     will be run on the first drive in the list
  248.                                     (in this example it will be DF0:).
  249.  
  250.  
  251.                                   If you specify instead:
  252.  
  253.  
  254.                                         'DEVICE0=PC0:DF0:'
  255.  
  256.  
  257.                                     if the disk in unreadable or not recognized
  258.                                     it will be formatted as 'PC0:'.
  259.  
  260.  
  261.                                   If one or more of the specified drives is not
  262.                                     mounted, it will be simply ignored.
  263.  
  264.  
  265.  
  266.  
  267.           BREAK_WARN            : When CatchDisk terminates because of a
  268.                                   ^C signal, it displays a requester
  269.                                   informing you of the event only if BREAK_WARN
  270.                                   is set.
  271.  
  272.  
  273.  
  274.           RESCAN=<secs>         : Forces CatchDisk to perform a new scan of all
  275.                                   devices every <secs> seconds. This allows
  276.                                   CatchDisk to detect the mounting of a device
  277.                                   that doesn't issue the 'diskinserted' message
  278.                                   (e.g. fake disks created with FMS).
  279.                                   Default value = 0 (no rescan).
  280.  
  281.  
  282.  
  283.           FORMATTER=<path&file> : Allows to specify a format program
  284.                                   different from 'SYS:System/Format' which
  285.                                   is the default. You must specify the complete
  286.                                   path/filename.
  287.  
  288.  
  289.  
  290.           ID<x>=<id>[,<name>[,<path&file>]] :
  291.                                   Describes a non-DOS disk format.
  292.                                   The digit <x> can range from 0 to 9: lower
  293.                                    numbers are checked first. 
  294.  
  295.  
  296.                                   <id> is a four-character identifier which
  297.                                     must match the first 4 bytes of
  298.                                     track 0 of a disk to identify it.
  299.                                     There are two special characters:
  300.  
  301.  
  302.                                         $ : Matches only a numeric digit (0-9)
  303.                                             or a '$'.
  304.  
  305.  
  306.                                         ? : Matches any character.
  307.  
  308.  
  309.                                     So, for example, Qb$$ matches any Quarterback
  310.                                     disk (Qb01, Qb02 etc.).
  311.  
  312.  
  313.                                   <name> is a text that will be used to tell 
  314.                                     the user what kind of disk CatchDisk has
  315.                                     identified. It will also be used as the label
  316.                                     for the middle gadget of the requester (see
  317.                                     below). If it is not given, the disk will
  318.                                     be always ignored, regardless of the
  319.                                     REQUESTER tooltype.
  320.  
  321.  
  322.                                   <file&path> is the path and filename of the
  323.                                     program to run when CatchDisk identifies
  324.                                     this disk format. This is the default
  325.                                     action which CatchDisk takes if REQUESTER
  326.                                     is NOID or NEVER. If <file&path> is not
  327.                                     given it defaults to the format program.
  328.  
  329.  
  330.                                   You can find some examples in CatchDisk's
  331.                                     icon.
  332.  
  333.  
  334.  
  335.           REQUESTER=<when>      : Where <when> is NEVER, ID, NOID or ALWAYS.
  336.                                   When CatchDisk detects a non-DOS disk, it can
  337.                                     take a default action or it can open a
  338.                                     requester asking the user what action
  339.                                     to take.
  340.  
  341.  
  342.                                   For unreadable/unrecognized disks the
  343.                                     actions are 'Ignore' or 'Format', with the
  344.                                     default being 'Format'.
  345.  
  346.  
  347.                                   For recognized disks the actions are 'Ignore'
  348.                                     'Format' or 'run the user-program', as set
  349.                                      in the respective ID<x>
  350.                                      tooltype.  The default is to run the
  351.                                      user-program.                                
  352.  
  353.  
  354.                                   If <when>=NEVER, CatchDisk always proceeds
  355.                                     without asking the user, and takes the
  356.                                     default action (see above).
  357.  
  358.  
  359.                                   If <when>=ID, CatchDisk opens the requester
  360.                                     only for identified disks, otherwise it
  361.                                     takes the default action.
  362.  
  363.  
  364.                                   If <when>=NOID, CatchDisk opens the
  365.                                     requester only for unreadable/unrecognized
  366.                                     disks, otherwise it takes the default action.
  367.  
  368.  
  369.                                   If <when>=ALWAYS, CatchDisk always opens the
  370.                                     requester.
  371.  
  372.  
  373.  
  374.    Once CatchDisk is active you can use the Commodities Exchange program to
  375. control its activities.
  376.  
  377.  
  378.  
  379. ---------------------
  380. Terminating CatchDisk
  381. ---------------------
  382.  
  383.  
  384.  
  385. As a commodity, CatchDisk can be terminated in three ways:
  386.  
  387.  
  388.   a) Run CatchDisk a second time.
  389.  
  390.  
  391.   b) Use the Commodities Exchange program.
  392.  
  393.  
  394.   c) Send CatchDisk a 'control-C' signal (see also BREAK_WARN):
  395.  
  396.  
  397.     c.1) If you started CatchDisk from workbench (or WBStartup drawer) use a
  398.          task control utility such as TaskX by Steve Tibbet.
  399.  
  400.  
  401.     c.2) If you started CatchDisk from a CLI (or user-startup) do the following:
  402.  
  403.  
  404.           1) Open a CLI
  405.           2) Issue the 'STATUS' command and note the process number of CatchDisk
  406.           3) Issue 'BREAK <n> C' where <n> is the process number noted above
  407.  
  408.  
  409.  
  410. -----------------
  411. Contact Addresses
  412. -----------------
  413.  
  414.  
  415.                            Criticism and suggestions
  416.                            -------------------------
  417.  
  418.  
  419.    I hope you will find CatchDisk useful, and if you have any criticism,
  420. suggestions, bug report, ideas for enhancements in possible future versions,
  421. or if you have problems using CatchDisk and need help, you can write ( in
  422. Italian or English ) to the following address:
  423.  
  424.  
  425.         Alessandro Sala
  426.         Via A. Grandi, 16
  427.         20014 Nerviano (MI)
  428.         Italy
  429.  
  430.  
  431.         If you have E-Mail capability you can also contact me at the following
  432. Internet (new) address (at least until the end of July, 1994):
  433.  
  434.  
  435.         tser1500@cdc8g5.cdc.polimi.it
  436.  
  437.  
  438.  
  439. ----------------
  440. Revision history
  441. ----------------
  442.  
  443.  
  444. **********************************************************************************
  445.                                     History
  446. **********************************************************************************
  447.  
  448.  
  449. ------------
  450. Version 1.20
  451. ------------
  452.  
  453.  
  454.     - Removed several bugs when more than one PCx: device is mounted (duplicated
  455.     format requests, format requests when removing a disk etc.). Problems in
  456.     detecting NDOS disks when a PCx: device is mounted should now be solved. 
  457.  
  458.  
  459.     - Added the ability to identify non-DOS disks (suggested by Jan-Claas
  460.     Dirks too) and take user-defined actions.
  461.  
  462.  
  463.     - Added optional requesters before any action is taken.
  464.  
  465.  
  466.     - Added the ability to run a user-defined format program.
  467.  
  468.  
  469.     - Added German language support (thanks to Jan-Claas Dirks).
  470.  
  471.  
  472.  
  473. ------------
  474. Version 1.10
  475. ------------
  476.  
  477.  
  478.     - When you re-enable CatchDisk, after having disabled it using 'Exchange',
  479.     it now performs a new scan of the various devices to see if there is any
  480.     new disk to be formatted.
  481.  
  482.  
  483.     - Added the 'RESCAN=<secs>' tooltype which forces CatchDisk to perform a
  484.     new scan of all devices every <secs> seconds, in order to detect the
  485.     mounting of devices that don't issue a 'diskinserted' message, such as
  486.     FMS fake disks (reported by Frank Schliefer).
  487.  
  488.  
  489.  
  490. ------------
  491. Version 1.00
  492. ------------
  493.  
  494.  
  495.      First release.
  496.